/*! \file bsl_types.h
 *
 * Broadcom System Log (BSL)
 *
 * BSL data types and macros.
 */
/*
 * Copyright: (c) 2018 Broadcom. All Rights Reserved. "Broadcom" refers to 
 * Broadcom Limited and/or its subsidiaries.
 * 
 * Broadcom Switch Software License
 * 
 * This license governs the use of the accompanying Broadcom software. Your 
 * use of the software indicates your acceptance of the terms and conditions 
 * of this license. If you do not agree to the terms and conditions of this 
 * license, do not use the software.
 * 1. Definitions
 *    "Licensor" means any person or entity that distributes its Work.
 *    "Software" means the original work of authorship made available under 
 *    this license.
 *    "Work" means the Software and any additions to or derivative works of 
 *    the Software that are made available under this license.
 *    The terms "reproduce," "reproduction," "derivative works," and 
 *    "distribution" have the meaning as provided under U.S. copyright law.
 *    Works, including the Software, are "made available" under this license 
 *    by including in or with the Work either (a) a copyright notice 
 *    referencing the applicability of this license to the Work, or (b) a copy 
 *    of this license.
 * 2. Grant of Copyright License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    copyright license to reproduce, prepare derivative works of, publicly 
 *    display, publicly perform, sublicense and distribute its Work and any 
 *    resulting derivative works in any form.
 * 3. Grant of Patent License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    patent license to make, have made, use, offer to sell, sell, import, and 
 *    otherwise transfer its Work, in whole or in part. This patent license 
 *    applies only to the patent claims licensable by Licensor that would be 
 *    infringed by Licensor's Work (or portion thereof) individually and 
 *    excluding any combinations with any other materials or technology.
 *    If you institute patent litigation against any Licensor (including a 
 *    cross-claim or counterclaim in a lawsuit) to enforce any patents that 
 *    you allege are infringed by any Work, then your patent license from such 
 *    Licensor to the Work shall terminate as of the date such litigation is 
 *    filed.
 * 4. Redistribution
 *    You may reproduce or distribute the Work only if (a) you do so under 
 *    this License, (b) you include a complete copy of this License with your 
 *    distribution, and (c) you retain without modification any copyright, 
 *    patent, trademark, or attribution notices that are present in the Work.
 * 5. Derivative Works
 *    You may specify that additional or different terms apply to the use, 
 *    reproduction, and distribution of your derivative works of the Work 
 *    ("Your Terms") only if (a) Your Terms provide that the limitations of 
 *    Section 7 apply to your derivative works, and (b) you identify the 
 *    specific derivative works that are subject to Your Terms. 
 *    Notwithstanding Your Terms, this license (including the redistribution 
 *    requirements in Section 4) will continue to apply to the Work itself.
 * 6. Trademarks
 *    This license does not grant any rights to use any Licensor's or its 
 *    affiliates' names, logos, or trademarks, except as necessary to 
 *    reproduce the notices described in this license.
 * 7. Limitations
 *    Platform. The Work and any derivative works thereof may only be used, or 
 *    intended for use, with a Broadcom switch integrated circuit.
 *    No Reverse Engineering. You will not use the Work to disassemble, 
 *    reverse engineer, decompile, or attempt to ascertain the underlying 
 *    technology of a Broadcom switch integrated circuit.
 * 8. Termination
 *    If you violate any term of this license, then your rights under this 
 *    license (including the license grants of Sections 2 and 3) will 
 *    terminate immediately.
 * 9. Disclaimer of Warranty
 *    THE WORK IS PROVIDED "AS IS" WITHOUT WARRANTIES OR CONDITIONS OF ANY 
 *    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WARRANTIES OR CONDITIONS OF 
 *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR 
 *    NON-INFRINGEMENT. YOU BEAR THE RISK OF UNDERTAKING ANY ACTIVITIES UNDER 
 *    THIS LICENSE. SOME STATES' CONSUMER LAWS DO NOT ALLOW EXCLUSION OF AN 
 *    IMPLIED WARRANTY, SO THIS DISCLAIMER MAY NOT APPLY TO YOU.
 * 10. Limitation of Liability
 *    EXCEPT AS PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL 
 *    THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE 
 *    SHALL ANY LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, 
 *    INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF 
 *    OR RELATED TO THIS LICENSE, THE USE OR INABILITY TO USE THE WORK 
 *    (INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL, BUSINESS INTERRUPTION, 
 *    LOST PROFITS OR DATA, COMPUTER FAILURE OR MALFUNCTION, OR ANY OTHER 
 *    COMMERCIAL DAMAGES OR LOSSES), EVEN IF THE LICENSOR HAS BEEN ADVISED OF 
 *    THE POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef BSL_TYPES_H
#define BSL_TYPES_H

/* Required for variable number of arguments */
#include <stdarg.h>

/*! Optionally define NULL to avoid dependency on external header files. */
#ifndef NULL
#define NULL (void *)0
#endif

/* Auto-generated layers and levels */
#include <bsl/bsl_enum.h>

/*! Compact representation of log message origin. */
typedef unsigned int bsl_packed_meta_t;

/*!
 * \name Log message formatting options.
 * \anchor BSL_META_OPT_xxx
 */

/*! \{ */

/*! Indicates that this message contains the beginning of a log message. */
#define BSL_META_OPT_START      0x1

/*! Indicates that this message contains the end of a log message. */
#define BSL_META_OPT_END        0x2

/*! Request a newline between the prefix and the main log message. */
#define BSL_META_OPT_PFX_NL     0x4

/*! \} */

/*! Meta data to accompany each log message. */
typedef struct bsl_meta_s {

    /*! Log output options (see \ref BSL_META_OPT_xxx). */
    unsigned int options;

    /*! Name of function which sent this message. */
    const char *func;

    /*! Name of source file which sent this message. */
    const char *file;

    /*! Line number of source file which sent this message. */
    int line;

    /*! Logging layer for this message. */
    bsl_layer_t layer;

    /*! Logging source for this message. */
    bsl_source_t source;

    /*! Severity level for this message. */
    bsl_severity_t severity;

    /*! Unit number for this message. */
    int unit;

    /*! Port number for this message. */
    int port;

    /*! Extra (context-dependent) parameter for this message, e.g. COS queue. */
    int xtra;

} bsl_meta_t;

/*! Constant to indicate unknown unit number. */
#define BSL_UNIT_UNKNOWN    (-1)

/*!
 * \brief Function to output log message.
 *
 * This is an application-provided function for outputting log
 * messages to one or more output sinks (terminal, file, etc.).
 *
 * \param [in] meta Meta data for this log message.
 * \param [in] format A printf-style format string.
 * \param [in] args List of printf-style arguments.
 *
 * \return Negative value on error.
 */
typedef int (*bsl_out_hook_f)(bsl_meta_t *meta, const char *format, va_list args);

/*!
 * \brief Check if log message should be output.
 *
 * This application-provided function should check whether a log
 * message should be passed to the output function at all.
 *
 * The function wil be called for all log messages in the execution
 * path, so it must be highly optimized.
 *
 * \param [in] meta_pack Packed meta data.
 *
 * \retval true if message should be passed to the output function.
 * \retval false if message should be skipped.
 */
typedef int (*bsl_check_hook_f)(bsl_packed_meta_t meta_pack);

/*! BSL configuration structure provided by the application. */
typedef struct bsl_config_s {

    /*! Function to output log messages. */
    bsl_out_hook_f out_hook;

    /*! Function to check if log message should be output. */
    bsl_check_hook_f check_hook;

} bsl_config_t;

#endif /* BSL_TYPES_H */
